$.fn.symphonyTimeAgo - Code Metrics - Inspection of "Set session name to prevent collisions on subdomai..." - symphonycms/symphony-2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#2843)

by Brendan

created 2018-05-20 22:06 UTC

$.fn.symphonyTimeAgo B

↳ Parent: symphony/assets/js/src/symphony.timeago.js

Complexity

Conditions	1
Paths	1

Size

Total Lines

105

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	105
rs	8.2857

How to fix Long Method

/**
 * @package assets
 */

(function($, Symphony) {

	/**
	 * Convert absolute to relative dates.
	 *
	 * @name $.symphonyTimeAgo
	 * @class
	 *
	 * @param {Object} options An object specifying containing the attributes specified below
	 * @param {String} [options.items='time'] Selector to find the absolute date
	 * @param {String} [options.timestamp='utc'] Attribute of `object.items` representing the timestamp of the given date
	 * @param {Integer} [options.max=0] Plugin will disable when the minutes exceed this value. By default this behaviour is off.
	 *
	 * @example

			$('.notifier').symphonyTimeAgo();
	 */
	$.fn.symphonyTimeAgo = function(options) {
		var objects = this,
			settings = {
				items: 'time',
				timestamp: 'utc',
				max: 0
			};

		$.extend(settings, options);

	/*-----------------------------------------------------------------------*/

		Symphony.Language.add({
			'just now': false,
			'a minute ago': false,
			'{$minutes} minutes ago': false,
			'about 1 hour ago': false,
			'about {$hours} hours ago': false
		});

	/*-------------------------------------------------------------------------
		Functions
	-------------------------------------------------------------------------*/

		function parse(item) {
			var timestamp = item.data('timestamp'),
				datetime;

			// Fetch stored timestamp
			if($.isNumeric(timestamp)) {
				return timestamp;
			}

			// Parse date
			else {

				datetime = item.attr(settings.timestamp);

				// Defined date and time
				if(datetime) {
					// Datetime will be in seconds since Epoch, JS requires
					// millseconds, so multiply by 1000.
					timestamp = new Date(datetime * 1000);
				}

				// Undefined date and time
				else {
					timestamp = new Date().getTime();
				}

				// Store and return timestamp
				item.data('timestamp', timestamp);
				return timestamp;
			}
		}

		function say(from, to) {

			// Calculate time difference
			var distance = to - from,

			// Convert time to minutes
			time = Math.floor(distance / 60000);

			// Return relative date based on passed time
			if(time < 1) {
				return Symphony.Language.get('just now');
			}
			if(time < 2) {
				return Symphony.Language.get('a minute ago');
			}
			if(time < 45) {
				return Symphony.Language.get('{$minutes} minutes ago', {
					'minutes': time
				});
			}
			if(time < 90) {
				return Symphony.Language.get('about 1 hour ago');
			}
			else if (!settings.max || time < settings.max) {
function isBig(a) {
    if (a > 5000) {
        return "yes";
    }
}

console.log(isBig(5001)); //returns yes
console.log(isBig(42)); //returns undefined
				return Symphony.Language.get('about {$hours} hours ago', {
					'hours': Math.floor(time / 60)
				});
			}
		}

	/*-------------------------------------------------------------------------
		Initialisation
	-------------------------------------------------------------------------*/

		objects.find(settings.items).each(function timeago() {
			var item = $(this),
				from = parse(item),
				to = new Date(),
				rel = say(from, to);

			// Set relative time
			if (rel) {
				item.text(rel);
			}
		});

	/*-----------------------------------------------------------------------*/

		return objects;
	};

})(window.jQuery, window.Symphony);


1			/**
2			* @package assets
3			*/
4
5			(function($, Symphony) {
6
7			/**
8			* Convert absolute to relative dates.
9			*
10			* @name $.symphonyTimeAgo
11			* @class
12			*
13			* @param {Object} options An object specifying containing the attributes specified below
14			* @param {String} [options.items='time'] Selector to find the absolute date
15			* @param {String} [options.timestamp='utc'] Attribute of `object.items` representing the timestamp of the given date
16			* @param {Integer} [options.max=0] Plugin will disable when the minutes exceed this value. By default this behaviour is off.
17			*
18			* @example
19
20			$('.notifier').symphonyTimeAgo();
21			*/
22			$.fn.symphonyTimeAgo = function(options) {
23			var objects = this,
24			settings = {
25			items: 'time',
26			timestamp: 'utc',
27			max: 0
28			};
29
30			$.extend(settings, options);
31
32			/-----------------------------------------------------------------------/
33
34			Symphony.Language.add({
35			'just now': false,
36			'a minute ago': false,
37			'{$minutes} minutes ago': false,
38			'about 1 hour ago': false,
39			'about {$hours} hours ago': false
40			});
41
42			/*-------------------------------------------------------------------------
43			Functions
44			-------------------------------------------------------------------------*/
45
46			function parse(item) {
47			var timestamp = item.data('timestamp'),
48			datetime;
49
50			// Fetch stored timestamp
51			if($.isNumeric(timestamp)) {
52			return timestamp;
53			}
54
55			// Parse date
56			else {
			0 ignored issues – show Comprehensibility introduced 2018-04-27 20:50 UTC by Report Bug Copy Issue Report `else` is not necessary here since all `if` branches return, consider removing it to reduce nesting and make code more readable. Loading history...
57			datetime = item.attr(settings.timestamp);
58
59			// Defined date and time
60			if(datetime) {
61			// Datetime will be in seconds since Epoch, JS requires
62			// millseconds, so multiply by 1000.
63			timestamp = new Date(datetime * 1000);
64			}
65
66			// Undefined date and time
67			else {
68			timestamp = new Date().getTime();
69			}
70
71			// Store and return timestamp
72			item.data('timestamp', timestamp);
73			return timestamp;
74			}
75			}
76
77			function say(from, to) {
78
79			// Calculate time difference
80			var distance = to - from,
81
82			// Convert time to minutes
83			time = Math.floor(distance / 60000);
84
85			// Return relative date based on passed time
86			if(time < 1) {
87			return Symphony.Language.get('just now');
88			}
89			if(time < 2) {
90			return Symphony.Language.get('a minute ago');
91			}
92			if(time < 45) {
93			return Symphony.Language.get('{$minutes} minutes ago', {
94			'minutes': time
95			});
96			}
97			if(time < 90) {
98			return Symphony.Language.get('about 1 hour ago');
99			}
100			else if (!settings.max \|\| time < settings.max) {
			0 ignored issues – show Complexity Best Practice introduced 2018-04-27 20:50 UTC by Report Bug Copy Issue Report There is no return statement if `!settings.max \|\| time < settings.max` is `false`. Are you sure this is correct? If so, consider adding `return;` explicitly. This check looks for functions where a `return` statement is found in some execution paths, but not in all. Consider this little piece of code function isBig(a) { if (a > 5000) { return "yes"; } } console.log(isBig(5001)); //returns yes console.log(isBig(42)); //returns undefined The function `isBig` will only return a specific value when its parameter is bigger than 5000. In any other case, it will implicitly return `undefined`. This behaviour may not be what you had intended. In any case, you can add a `return undefined` to the other execution path to make the return value explicit. Loading history...
101			return Symphony.Language.get('about {$hours} hours ago', {
102			'hours': Math.floor(time / 60)
103			});
104			}
105			}
106
107			/*-------------------------------------------------------------------------
108			Initialisation
109			-------------------------------------------------------------------------*/
110
111			objects.find(settings.items).each(function timeago() {
112			var item = $(this),
113			from = parse(item),
114			to = new Date(),
115			rel = say(from, to);
116
117			// Set relative time
118			if (rel) {
119			item.text(rel);
120			}
121			});
122
123			/-----------------------------------------------------------------------/
124
125			return objects;
126			};
127
128			})(window.jQuery, window.Symphony);
129

symphonycms / symphony-2

GitHub Access Token became invalid

Pull Request — master (#2843)

$.fn.symphonyTimeAgo B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like